home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / pcbrt201.arc / PCBRAT.DOC < prev    next >
Text File  |  1989-01-11  |  8KB  |  171 lines
  1.                   PCBoard Auto Ratio Program for PCBoard 14.0
  2.                                  version 2.01
  3.                                    01-07-89
  4.                               by Alexander Morris
  5.                          (C) DataCom SoftWare 1987, 89
  6.                               BBS # (212) 496-7946
  7.  
  8. 1. Purpose
  9.  
  10.    The purpose of this program is to go through the entire user file and
  11. check all users upload/download ratios and re-set their access levels 
  12. according to your own specifications. There is also an optional message check,
  13. which allows you to keep the users who are more message active than file active
  14. from being dumped into a lower access level. 
  15.  
  16. 2. Setup
  17.  
  18.    This program is very similar to PCBREG, except in what it does. The 
  19. setup works the same, except that the setup file is called PCBRAT.DAT. As
  20. soon as the program runs, and that file is not found, it asks you if you would
  21. like to setup the program. If you answer 'no', then the program will exit,
  22. otherwise, it will put you through the whole set up. All the setup options
  23. must be filled in correctly, and if they are not, the program will most likely
  24. not work how you want it. When you are done this, you are required to make a
  25. simple text file called PCBRAT.RAT, which contains the ratio information. This
  26. file is very important, because it controls how PCBRAT handles the users. A
  27. sample line from a PCBRAT.RAT line would be as follows:
  28.  
  29. 50 R1=45>10 R2=55<5 NOLMSG
  30.  
  31. The first number indicates that the rest of the options on that line will
  32. pertain to access level 50 and ONLY 50. The R1 tells PCBRAT to lower the
  33. user to access level to 45 if his up/download ratio IS MORE THAN 1 to 10. R2
  34. tells the program that if the level 50 user has an up/download ratio of LESS
  35. THAN OR EQUAL TO 1 to 5, then make his access level 55. The NOLMSG flag is an
  36. option that will only be used if the answer to include message check in the
  37. setup is marked as yes. It tells PCBRAT "if a user has a poor upload/download
  38. ratio, but he is relatively up to date in reading his messages, do not lower
  39. him to 45, but keep him at level 50."
  40.  
  41. The following would also be necessary for proper operation when dealing
  42. with messages:
  43.  
  44. 45 R2=50<10 MSG
  45.  
  46. The line tells PCBRAT that if a level 45 user has a ratio of less than or
  47. equal to 10, then raise his access level back to 50. But if he does not have
  48. a good ratio (and the message option is set yes when configuring PCBRAT) and
  49. the MSG flag is found, to raise the user's access level back to 50 IF he is
  50. relatively up to date in reading his messages.
  51.  
  52. The reason that the NOLMSG flag was added was because there were conflicts
  53. with MSG that would cause users levels to be left the same when the should
  54. be lowered. The NOLMSG flag was the result of the need of another flag to
  55. crush the adjustment using messages bug.
  56.  
  57. Note that when you make your PCBRAT.RAT file, it must follow the same exact
  58. format as shown above (ie. < must be < , etc.). Also, make sure that there
  59. are NO blank lines anywhere above, inbetween, or below the actual lines to
  60. be processed. Listed below is the PCBRAT.RAT file use for my board:
  61.  
  62. 45 R2=50<10 MSG
  63. 50 R1=45>10 R2=55<5 NOLMSG
  64. 55 R1=50>5
  65. 60 R2=70<6
  66. 70 R1=60>6
  67.  
  68. Note also that any access level not marked will not be affected (ie. since
  69. no level 80 line is specified, all users with access level 80 will be
  70. ignored).
  71.  
  72. One more important thing. To make sure you have your setup file correct,
  73. run the program twice in a row, and if no users are changed the second run,
  74. then you know that you have correctly written your PCBRAT.RAT file. If not,
  75. just go back and see which two statements are overlapping, correct it, and
  76. try it again.
  77.  
  78. 3. Features
  79.  
  80.    PCBRAT has the following features:
  81.  
  82.     o  Customize your own ratios for each access level
  83.     o  Optionally back up the user file
  84.     o  Optionally add a message check when processing ratios using the
  85.          MSG and NOLMSG flags in the PCBRAT.RAT file and by setting the
  86.          add message check option to yes when configuring PCBRAT
  87.     o  Allows optional logging of PCBRAT activites
  88.     o  Tells you if your ratio file is incorrect (exits with an error)
  89.     o  Checks to see if user file is there
  90.     o  Specify paths to all files (except PCBRAT.DAT)
  91.     o  Disable ANSI.SYS codes used for color via a command line parameter
  92.     o  Allows remote use via the DOS CTTY command via special read/write
  93.         procedures
  94.     o  Written in Turbo Pascal 5.0
  95.     o  Compiles ratio file instantaneously upon every run
  96.     o  Gives statistics on number of users raised, lowered, etc.
  97.     o  Compatible with PCBoard 14.0 user file
  98.     o  Ignores users with 0:0 upload/download ratios
  99.     o  Gives account of each user who was raised or lowered in access
  100.     o  Also displays user number of user being updated
  101.     o  Fully supports file SHAREing so that no datafiles can get corrupted
  102.          while program is running under a network
  103.     o  Trap to make sure setup file from wrong version of PCBRAT is not
  104.          used by mistake
  105.     o  makes sure user file, ratio file, message file (if used) is present
  106.          in directory or file that was given in the setup
  107.     o  Shows number of users saved by message check (if message check active)
  108.  
  109. 4. Operation
  110.  
  111.    PCBRAT also allows you to disable the ANSI.SYS codes used for color by
  112. specifying the command line parameter -a  or  -A  (ie. PCBREG -a). That is
  113. essentially all that must be said about the program. Everything else is 
  114. automatic after it is set up correctly. I have tested the program for about
  115. two months and can not find any errors anymore. This program, just like PCBREG,
  116. is most likely to be used a PCBoard event, a sample being as follows:
  117. Note: C:\PCB is PCBoard's directory, C:\PCB\MAIN is PCBoard's main directory
  118.  
  119. C>copy con:event.sys
  120. c:
  121. cd\pcb\main
  122. pcbrat
  123. cd\pcb
  124. board
  125. (ctrl-Z)(CR)
  126. 1 file(s) copied
  127. C>
  128.  
  129. File SHAREing is fully supported, so PCBoard and PCBRAT can be running
  130. simultaneously without any fear of data loss or corruption! This should
  131. please the increasing multi-node PCBoard PCBRAT users out there!
  132.  
  133. 5. Disclaimer
  134.  
  135.    If this program ruins any or all of your files, then do not blame me. If
  136. something like that occurs, then it is probably the result of your setting up
  137. the program incorrectly. I have tested the program out quite thoroughly, and am
  138. quite sure that nothing of the sort would occur.
  139.  
  140. 6. Miscellaneous
  141.  
  142.    If you find the program a necessity which you could not do without, I 
  143. ask that you give a donation. A donation of $25 is recommended, and should 
  144. be mailed to the following address:
  145.  
  146.                         Alexander Morris
  147.                         DataCom SoftWare (PCBRAT)
  148.                         15 W. 81st Street
  149.                         New York, NY 10024
  150.  
  151. If you do not give a donation, you will feel forever guilty for not helping
  152. a fellow sysop by supporting his hard work. For version information, check
  153. the file UPDATES.RAT.
  154.  
  155. NOTE: If you use this program, I REQUEST that you notify all of your users
  156. via the news file or something similar that your are using this program
  157. (and/or PCBREG) in your PCBoard operation.
  158.  
  159. 7. Board Information / Bug Info
  160.  
  161.    If you find any bugs, please call my board and report them!
  162.  
  163.    My board number and stats are listed below:
  164.  
  165. DataCom SoftWare BBS
  166. (212) 496-7946
  167. 24 hours, 7 days a week, USR HST 1200/2400/9600/19200 baud!
  168. running PCBoard 14.0/E3 -- specializing in Turbo Pascal, MIDI
  169.                            LaserJet, Graphics, and much, much more!!!
  170.  
  171.